<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Reranker Framework (ReFr): reranker::EndOfEpochModelWriter Class Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />

<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>

</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">Reranker Framework (ReFr)
   
   </div>
   <div id="projectbrief">Reranking framework for structure prediction and discriminative language modeling</div>
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.6.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Defines</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="namespacereranker.html">reranker</a>      </li>
      <li class="navelem"><a class="el" href="classreranker_1_1_end_of_epoch_model_writer.html">EndOfEpochModelWriter</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">reranker::EndOfEpochModelWriter Class Reference</div>  </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="reranker::EndOfEpochModelWriter" --><!-- doxytag: inherits="reranker::Model::Hook" -->
<p>An end-of-epoch hook for writing out the best model so far to file after each epoch (if the best model changes from the last time it was written out).  
 <a href="classreranker_1_1_end_of_epoch_model_writer.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="model-proto-writer_8_h_source.html">model-proto-writer.H</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for reranker::EndOfEpochModelWriter:</div>
<div class="dyncontent">
 <div class="center">
  <img src="classreranker_1_1_end_of_epoch_model_writer.png" usemap="#reranker::EndOfEpochModelWriter_map" alt=""/>
  <map id="reranker::EndOfEpochModelWriter_map" name="reranker::EndOfEpochModelWriter_map">
<area href="classreranker_1_1_model_1_1_hook.html" title="An interface for specifying a hook to be run by a Model instance." alt="reranker::Model::Hook" shape="rect" coords="0,0,208,24"/>
</map>
 </div></div>

<p><a href="classreranker_1_1_end_of_epoch_model_writer-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classreranker_1_1_end_of_epoch_model_writer.html#ad48473d4c497e1bcb2aee00e918f609b">EndOfEpochModelWriter</a> (const string &amp;model_file, shared_ptr&lt; <a class="el" href="classreranker_1_1_model_proto_writer.html">ModelProtoWriter</a> &gt; writer, bool compressed, bool use_base64, bool verbose=true)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a new instance to write out the best model to the specified file.  <a href="#ad48473d4c497e1bcb2aee00e918f609b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classreranker_1_1_end_of_epoch_model_writer.html#ae7b2e80d80d1fe56705b07b175a1418e">Do</a> (<a class="el" href="classreranker_1_1_model.html">Model</a> *model)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Executes this end-of-epoch hook, which writes out the best model so far if its epoch differs from that of the last model written out by this hook.  <a href="#ae7b2e80d80d1fe56705b07b175a1418e"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>An end-of-epoch hook for writing out the best model so far to file after each epoch (if the best model changes from the last time it was written out). </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classreranker_1_1_model.html#a82524ee041462b4f7be0b35bed8e27c1">Model::set_end_of_epoch_hook</a> </dd></dl>

<p>Definition at line <a class="el" href="model-proto-writer_8_h_source.html#l00134">134</a> of file <a class="el" href="model-proto-writer_8_h_source.html">model-proto-writer.H</a>.</p>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ad48473d4c497e1bcb2aee00e918f609b"></a><!-- doxytag: member="reranker::EndOfEpochModelWriter::EndOfEpochModelWriter" ref="ad48473d4c497e1bcb2aee00e918f609b" args="(const string &amp;model_file, shared_ptr&lt; ModelProtoWriter &gt; writer, bool compressed, bool use_base64, bool verbose=true)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classreranker_1_1_end_of_epoch_model_writer.html#ad48473d4c497e1bcb2aee00e918f609b">reranker::EndOfEpochModelWriter::EndOfEpochModelWriter</a> </td>
          <td>(</td>
          <td class="paramtype">const string &amp;&#160;</td>
          <td class="paramname"><em>model_file</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">shared_ptr&lt; <a class="el" href="classreranker_1_1_model_proto_writer.html">ModelProtoWriter</a> &gt;&#160;</td>
          <td class="paramname"><em>writer</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>compressed</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>use_base64</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>verbose</em> = <code>true</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Constructs a new instance to write out the best model to the specified file. </p>
<p>A model will only be serialized if the best model epoch so far is different from that of the last model written out by this hook.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">model_file</td><td>the name of the file to which to serialize a <a class="el" href="classreranker_1_1_model.html">Model</a> </td></tr>
    <tr><td class="paramname">writer</td><td>the serializer for serializing a <a class="el" href="classreranker_1_1_model.html">Model</a> to a <code>ModelMessage</code> </td></tr>
    <tr><td class="paramname">compressed</td><td>whether to use compression when serializing a <a class="el" href="classreranker_1_1_model.html">Model</a> </td></tr>
    <tr><td class="paramname">use_base64</td><td>whether to serialize using base64 encoding </td></tr>
    <tr><td class="paramname">verbose</td><td>whether this end-of-epoch hook should be verbose</td></tr>
  </table>
  </dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classreranker_1_1_model.html#a82524ee041462b4f7be0b35bed8e27c1">Model::set_end_of_epoch_hook</a> </dd></dl>

<p>Definition at line <a class="el" href="model-proto-writer_8_h_source.html#l00150">150</a> of file <a class="el" href="model-proto-writer_8_h_source.html">model-proto-writer.H</a>.</p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ae7b2e80d80d1fe56705b07b175a1418e"></a><!-- doxytag: member="reranker::EndOfEpochModelWriter::Do" ref="ae7b2e80d80d1fe56705b07b175a1418e" args="(Model *model)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void <a class="el" href="classreranker_1_1_end_of_epoch_model_writer.html#ae7b2e80d80d1fe56705b07b175a1418e">reranker::EndOfEpochModelWriter::Do</a> </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classreranker_1_1_model.html">Model</a> *&#160;</td>
          <td class="paramname"><em>model</em></td><td>)</td>
          <td><code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Executes this end-of-epoch hook, which writes out the best model so far if its epoch differs from that of the last model written out by this hook. </p>
<p>For safety, the model will be first serialized to a temporary file and then moved into place.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">model</td><td>the model that will execute this hook in its <a class="el" href="classreranker_1_1_model.html#a0392df23892406abcbf21bbe1bf5392a">Model::EndOfEpoch</a> method</td></tr>
  </table>
  </dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classreranker_1_1_model.html#a82524ee041462b4f7be0b35bed8e27c1">Model::set_end_of_epoch_hook</a> </dd></dl>

<p>Implements <a class="el" href="classreranker_1_1_model_1_1_hook.html#a676b9a02709b0a61856a8ff246f182d6">reranker::Model::Hook</a>.</p>

<p>Definition at line <a class="el" href="model-proto-writer_8_h_source.html#l00168">168</a> of file <a class="el" href="model-proto-writer_8_h_source.html">model-proto-writer.H</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="model-proto-writer_8_h_source.html">model-proto-writer.H</a></li>
</ul>
</div><!-- contents -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Defines</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>



<hr class="footer"/><address class="footer"><small>
Generated on Tue Apr 9 2013 11:56:31 for Reranker Framework (ReFr) by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>

</body>
</html>
